<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content=
    "application/xhtml+xml; charset=iso-8859-1" />
    <title>
      Rarian-0.8.1
    </title>
    <link rel="stylesheet" type="text/css" href="../stylesheets/lfs.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="stylesheet" href="../stylesheets/lfs-print.css" type=
    "text/css" media="print" />
  </head>
  <body class="blfs" id="blfs-2020-04-02">
    <div class="navheader">
      <h4>
        Beyond Linux<sup>�</sup> From Scratch <span class="phrase">(System
        V</span> Edition) - Version 2020-04-02
      </h4>
      <h3>
        Chapter&nbsp;11.&nbsp;General Utilities
      </h3>
      <ul>
        <li class="prev">
          <a accesskey="p" href="pinentry.html" title=
          "pinentry-1.1.0">Prev</a>
          <p>
            pinentry-1.1.0
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="rep-gtk.html" title=
          "Rep-gtk-0.90.8.3">Next</a>
          <p>
            Rep-gtk-0.90.8.3
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="genutils.html" title=
          "Chapter&nbsp;11.&nbsp;General Utilities">Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 2020-04-02">
          Home</a>
        </li>
      </ul>
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <h1 class="sect1">
        <a id="rarian" name="rarian"></a>Rarian-0.8.1
      </h1>
      <div class="package" lang="en" xml:lang="en">
        <h2 class="sect2">
          Introduction to Rarian
        </h2>
        <p>
          The <span class="application">Rarian</span> package is a
          documentation metadata library based on the proposed
          Freedesktop.org spec. <span class="application">Rarian</span> is
          designed to be a replacement for <span class=
          "application">ScrollKeeper</span>.
        </p>
        <p>
          This package is known to build and work properly using an LFS-9.1
          platform.
        </p>
        <h3>
          Package Information
        </h3>
        <div class="itemizedlist">
          <ul class="compact">
            <li class="listitem">
              <p>
                Download (HTTP): <a class="ulink" href=
                "http://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2">
                http://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download (FTP): <a class="ulink" href=
                "ftp://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2">
                ftp://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download MD5 sum: 75091185e13da67a0ff4279de1757b94
              </p>
            </li>
            <li class="listitem">
              <p>
                Download size: 317 KB
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated disk space required: 6 MB
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated build time: 0.2 SBU
              </p>
            </li>
          </ul>
        </div>
        <h3>
          Rarian Dependencies
        </h3>
        <h4>
          Recommended
        </h4>
        <p class="recommended">
          <a class="xref" href="libxslt.html" title=
          "libxslt-1.1.34">libxslt-1.1.34</a> (<span class=
          "command"><strong>rarian-sk-extract</strong></span> will not be
          built without this) and <a class="xref" href="../pst/docbook.html"
          title="docbook-xml-4.5">docbook-xml-4.5</a> (without this,
          <span class="application">Rarian</span> scripts source DTDs from
          the net)
        </p>
        <p class="usernotes">
          User Notes: <a class="ulink" href=
          "http://wiki.linuxfromscratch.org/blfs/wiki/rarian">http://wiki.linuxfromscratch.org/blfs/wiki/rarian</a>
        </p>
      </div>
      <div class="installation" lang="en" xml:lang="en">
        <h2 class="sect2">
          Installation of Rarian
        </h2>
        <p>
          Install <span class="application">Rarian</span> by running the
          following commands:
        </p>
        <pre class="userinput">
<kbd class="command">./configure --prefix=/usr        \
            --disable-static     \
            --localstatedir=/var &amp;&amp;
make</kbd>
</pre>
        <p>
          This package does not come with a test suite.
        </p>
        <p>
          Now, as the <code class="systemitem">root</code> user:
        </p>
        <pre class="root">
<kbd class="command">make install</kbd>
</pre>
      </div>
      <div class="commands" lang="en" xml:lang="en">
        <h2 class="sect2">
          Command Explanations
        </h2>
        <p>
          <em class="parameter"><code>--disable-static</code></em>: This
          switch prevents installation of static versions of the libraries.
        </p>
      </div>
      <div class="content" lang="en" xml:lang="en">
        <h2 class="sect2">
          Contents
        </h2>
        <div class="segmentedlist">
          <div class="seglistitem">
            <div class="seg">
              <strong class="segtitle">Installed Programs:</strong>
              <span class="segbody">rarian-example, rarian-sk-config,
              rarian-sk-extract, rarian-sk-gen-uuid, rarian-sk-get-cl,
              rarian-sk-get-content-list,
              rarian-sk-get-extended-content-list, rarian-sk-get-scripts,
              rarian-sk-install, rarian-sk-migrate, rarian-sk-preinstall,
              rarian-sk-rebuild, and rarian-sk-update</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Library:</strong>
              <span class="segbody">librarian.so</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Directories:</strong>
              <span class="segbody">/usr/include/rarian, /usr/share/help,
              /usr/share/librarian/manual, /usr/share/librarian/Templates/C,
              and /var/lib/rarian</span>
            </div>
          </div>
        </div>
        <div class="variablelist">
          <h3>
            Short Descriptions
          </h3>
          <table border="0" class="variablelist">
            <colgroup>
              <col align="left" valign="top" />
              <col />
            </colgroup>
            <tbody>
              <tr>
                <td>
                  <p>
                    <a id="rarian-example" name=
                    "rarian-example"></a><span class="term"><span class=
                    "command"><strong>rarian-example</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    prints a nice list of all available documents found by
                    the library.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-config" name=
                    "rarian-sk-config"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-config</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    emulates <span class=
                    "command"><strong>scrollkeeper-config</strong></span>.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-extract" name=
                    "rarian-sk-extract"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-extract</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is a wrapper around xsltproc to mimic <span class=
                    "command"><strong>scrollkeeper-extract</strong></span>.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-gen-uuid" name=
                    "rarian-sk-gen-uuid"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-gen-uuid</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    generates a unique (random) uuid.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-get-cl" name=
                    "rarian-sk-get-cl"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-get-cl</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    gets a content list (category tree).
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-get-content-list" name=
                    "rarian-sk-get-content-list"></a><span class=
                    "term"><span class=
                    "command"><strong>rarian-sk-get-content-list</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is a simple wrapper to make calling <span class=
                    "command"><strong>scrollkeeper-get-cl</strong></span>
                    easier.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-get-extended-content-list" name=
                    "rarian-sk-get-extended-content-list"></a><span class=
                    "term"><span class=
                    "command"><strong>rarian-sk-get-extended-content-list</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is a simple wrapper to make calling <span class=
                    "command"><strong>scrollkeeper-get-cl</strong></span>
                    (extended) easier.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-get-scripts" name=
                    "rarian-sk-get-scripts"></a><span class=
                    "term"><span class=
                    "command"><strong>rarian-sk-get-scripts</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    emulates <span class=
                    "command"><strong>scrollkeeper-get-index-from-index-from-docpath</strong></span>,
                    <span class=
                    "command"><strong>scrollkeeper-get-toc-from-docpath</strong></span>,
                    and <span class=
                    "command"><strong>scrollkeeper-get-toc-from-id</strong></span>.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-install" name=
                    "rarian-sk-install"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-install</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    emulates <span class=
                    "command"><strong>scrollkeeper-install</strong></span>
                    and <span class=
                    "command"><strong>scrollkeeper-uninstall</strong></span>.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-migrate" name=
                    "rarian-sk-migrate"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-migrate</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    takes in a directory full of omf's, reads and parses them
                    and spews out an equivalent scroll file.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-preinstall" name=
                    "rarian-sk-preinstall"></a><span class=
                    "term"><span class="command"><strong>rarian-sk-preinstall</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    creates the omf file by reading an existing omf file and
                    replacing the url for a resource with the url.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-rebuild" name=
                    "rarian-sk-rebuild"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-rebuild</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is a simple wrapper script to emulate <span class=
                    "command"><strong>scrollkeeper-rebuilddb</strong></span>.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="rarian-sk-update" name=
                    "rarian-sk-update"></a><span class="term"><span class=
                    "command"><strong>rarian-sk-update</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is compatible with the <span class=
                    "command"><strong>scrollkeeper-update</strong></span>
                    script that's required to be run when installing new omf
                    files. It converts the omf files into new-style scrolls.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="librarian" name="librarian"></a><span class=
                    "term"><code class=
                    "filename">librarian.{so,a}</code></span>
                  </p>
                </td>
                <td>
                  <p>
                    is the API to build a list of available meta data files
                    and allows access to these.
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <p class="updated">
        Last updated on 2020-03-18 05:00:14 -0500
      </p>
    </div>
    <div class="navfooter">
      <ul>
        <li class="prev">
          <a accesskey="p" href="pinentry.html" title=
          "pinentry-1.1.0">Prev</a>
          <p>
            pinentry-1.1.0
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="rep-gtk.html" title=
          "Rep-gtk-0.90.8.3">Next</a>
          <p>
            Rep-gtk-0.90.8.3
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="genutils.html" title=
          "Chapter&nbsp;11.&nbsp;General Utilities">Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 2020-04-02">
          Home</a>
        </li>
      </ul>
    </div>
  </body>
</html>
